Pre-commit Hooks

概述

Pre-commit hooks是在代码提交到版本控制系统之前自动运行的脚本，用于执行格式化、代码检查、安全扫描等质量保证任务。

关键内容

1. 作用机制：
2. 在开发者执行 git commit 命令时触发
3. 验证即将提交的代码是否符合项目规范

4. 如检查失败则阻止提交，直到问题修复

5. 常见工具：

6. 格式化工具：Prettier、Black、gofmt、rustfmt 等
7. 代码检查工具：ESLint、Ruff、golangci-lint、Clippy 等
8. 安全扫描工具：Bandit、gosec、cargo-audit、npm audit 等

9. 类型检查工具：TypeScript、mypy、flow 等

10. 实施策略：

11. 根据项目语言选择匹配的工具集
12. 配置与CI/CD流水线一致的检查规则
13. 确保本地检查与远程检查行为相同

来源

• setup-ci-cd — 实现 pre-commit hooks 和 GitHub Actions 质量保障

相关

• CI/CD 流水线 — relates_to
• GitHub Actions — relates_to
• 代码质量 — relates_to
• DevOps — relates_to